<!doctype html>
<html>
<head>
    <title>Functions (idxCMS: Flat Files Content Management Sysytem ver. 5.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link href="../style.css" type="text/css" rel="stylesheet" />
</head>
<body>
    <div class="page">
        <div class="header center">
            <div class="content">
                idxCMS: Flat Files Content Management Sysytem ver. 5.0                <div class="logo_desc">Application Programming Interface</div>
            </div>
        </div>
        <div class="panel">
            <div class="content">
                <h1>Namespaces</h1>
<ul>
    <li><a href="../administration/package-summary.html">Administration</a></li>
    <li><a href="../catalogs/package-summary.html">Catalogs</a></li>
    <li><a href="../core/package-summary.html">Core</a></li>
    <li><a href="../forum/package-summary.html">Forum</a></li>
    <li><a href="../gallery/package-summary.html">Gallery</a></li>
    <li><a href="../no package/package-summary.html">No Package</a></li>
    <li><a href="../polls/package-summary.html">Polls</a></li>
    <li><a href="../posts/package-summary.html">Posts</a></li>
    <li><a href="../rss/package-summary.html">RSS</a></li>
    <li><a href="../rate/package-summary.html">Rate</a></li>
    <li><a href="../search/package-summary.html">Search</a></li>
    <li><a href="../statistics/package-summary.html">Statistics</a></li>
    <li><a href="../tagcloud/package-summary.html">Tagcloud</a></li>
    <li><a href="../template/package-summary.html">Template</a></li>
    <li><a href="../tools/package-summary.html">Tools</a></li>
    <li><a href="../user/package-summary.html">User</a></li>
</ul>
<h1>Namespace Core</h1>
    <h2>Classes</h2>
    <ul>
            <li><a href="../core/categories.html" title="Core \ CATEGORIES">CATEGORIES</a></li>
            <li><a href="../core/cms.html" title="Core \ CMS">CMS</a></li>
            <li><a href="../core/comments.html" title="Core \ COMMENTS">COMMENTS</a></li>
            <li><a href="../core/config.html" title="Core \ CONFIG">CONFIG</a></li>
            <li><a href="../core/content.html" title="Core \ CONTENT">CONTENT</a></li>
            <li><a href="../core/dbase.html" title="Core \ DBASE">DBASE</a></li>
            <li><a href="../core/filter.html" title="Core \ FILTER">FILTER</a></li>
            <li><a href="../core/highlighter.html" title="Core \ HIGHLIGHTER">HIGHLIGHTER</a></li>
            <li><a href="../core/image.html" title="Core \ IMAGE">IMAGE</a></li>
            <li><a href="../core/items.html" title="Core \ ITEMS">ITEMS</a></li>
            <li><a href="../core/log.html" title="Core \ LOG">LOG</a></li>
            <li><a href="../core/parser.html" title="Core \ PARSER">PARSER</a></li>
            <li><a href="../core/sections.html" title="Core \ SECTIONS">SECTIONS</a></li>
            <li><a href="../core/system.html" title="Core \ SYSTEM">SYSTEM</a></li>
            <li><a href="../core/uploader.html" title="Core \ UPLOADER">UPLOADER</a></li>
        </ul>
    <h2>Functions</h2>
    <ul>
            <li><a href="../core/package-functions.html#AdvScanDir" title="Core">AdvScanDir</a></li>
            <li><a href="../core/package-functions.html#AdvancedPagination" title="Core">AdvancedPagination</a></li>
            <li><a href="../core/package-functions.html#CheckCaptcha" title="Core">CheckCaptcha</a></li>
            <li><a href="../core/package-functions.html#CreateUrl" title="Core">CreateUrl</a></li>
            <li><a href="../core/package-functions.html#DeleteTree" title="Core">DeleteTree</a></li>
            <li><a href="../core/package-functions.html#FormatTime" title="Core">FormatTime</a></li>
            <li><a href="../core/package-functions.html#GetFilesList" title="Core">GetFilesList</a></li>
            <li><a href="../core/package-functions.html#GetPagination" title="Core">GetPagination</a></li>
            <li><a href="../core/package-functions.html#OnlyLatin" title="Core">OnlyLatin</a></li>
            <li><a href="../core/package-functions.html#Pagination" title="Core">Pagination</a></li>
            <li><a href="../core/package-functions.html#RandomString" title="Core">RandomString</a></li>
            <li><a href="../core/package-functions.html#Redirect" title="Core">Redirect</a></li>
            <li><a href="../core/package-functions.html#SelectTimeZone" title="Core">SelectTimeZone</a></li>
            <li><a href="../core/package-functions.html#SendMail" title="Core">SendMail</a></li>
            <li><a href="../core/package-functions.html#ShowCaptcha" title="Core">ShowCaptcha</a></li>
            <li><a href="../core/package-functions.html#Sitemap" title="Core">Sitemap</a></li>
            <li><a href="../core/package-functions.html#UnifyBr" title="Core">UnifyBr</a></li>
            <li><a href="../core/package-functions.html#" title="Core"></a></li>
            <li><a href="../core/package-functions.html#gzfile_get_contents" title="Core">gzfile_get_contents</a></li>
            <li><a href="../core/package-functions.html#gzfile_put_contents" title="Core">gzfile_put_contents</a></li>
            <li><a href="../core/package-functions.html#idxErrorHandler" title="Core">idxErrorHandler</a></li>
        </ul>
    <h2>Globals</h2>
    <ul>
            <li><a href="../core/package-globals.html#ADMIN" title="Core">ADMIN</a></li>
            <li><a href="../core/package-globals.html#ADMINLIBS" title="Core">ADMINLIBS</a></li>
            <li><a href="../core/package-globals.html#CACHE" title="Core">CACHE</a></li>
            <li><a href="../core/package-globals.html#CATEGORY" title="Core">CATEGORY</a></li>
            <li><a href="../core/package-globals.html#COMMENT" title="Core">COMMENT</a></li>
            <li><a href="../core/package-globals.html#CONTENT" title="Core">CONTENT</a></li>
            <li><a href="../core/package-globals.html#CURRENT_MODULE" title="Core">CURRENT_MODULE</a></li>
            <li><a href="../core/package-globals.html#CURRENT_SKIN" title="Core">CURRENT_SKIN</a></li>
            <li><a href="../core/package-globals.html#DS" title="Core">DS</a></li>
            <li><a href="../core/package-globals.html#IDX_COPYRIGHT" title="Core">IDX_COPYRIGHT</a></li>
            <li><a href="../core/package-globals.html#IDX_POWERED" title="Core">IDX_POWERED</a></li>
            <li><a href="../core/package-globals.html#IDX_VERSION" title="Core">IDX_VERSION</a></li>
            <li><a href="../core/package-globals.html#IMAGES" title="Core">IMAGES</a></li>
            <li><a href="../core/package-globals.html#ITEM" title="Core">ITEM</a></li>
            <li><a href="../core/package-globals.html#LF" title="Core">LF</a></li>
            <li><a href="../core/package-globals.html#LOGS" title="Core">LOGS</a></li>
            <li><a href="../core/package-globals.html#MODULE" title="Core">MODULE</a></li>
            <li><a href="../core/package-globals.html#MODULES" title="Core">MODULES</a></li>
            <li><a href="../core/package-globals.html#PAGE" title="Core">PAGE</a></li>
            <li><a href="../core/package-globals.html#ROOT" title="Core">ROOT</a></li>
            <li><a href="../core/package-globals.html#SECTION" title="Core">SECTION</a></li>
            <li><a href="../core/package-globals.html#SKINS" title="Core">SKINS</a></li>
            <li><a href="../core/package-globals.html#SMILES" title="Core">SMILES</a></li>
            <li><a href="../core/package-globals.html#SYS" title="Core">SYS</a></li>
            <li><a href="../core/package-globals.html#TEMP" title="Core">TEMP</a></li>
            <li><a href="../core/package-globals.html#TEMPLATES" title="Core">TEMPLATES</a></li>
            <li><a href="../core/package-globals.html#TOOLS" title="Core">TOOLS</a></li>
            <li><a href="../core/package-globals.html#USERS" title="Core">USERS</a></li>
            <li><a href="../core/package-globals.html#idxADMIN" title="Core">idxADMIN</a></li>
            <li><a href="../core/package-globals.html#idxCMS" title="Core">idxCMS</a></li>
        </ul>
            </div>
        </div>
        <div class="main">
            <div class="content">
                <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../core/package-summary.html">Namespace</a></li>
                    <li class="active">Function</li>
                    <li><a href="../core/package-tree.html">Core\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links"><a href="#details_functions">Functions</a></div>
</nav>
                <div class="package">Namespace Core</div>
<h1>Functions</h1>
<hr />
    <table id="summary_functions" class="title">
        <tr><th colspan="2" class="title">Functions: summary</th></tr>
                    <tr>
                <td class="type w_200">public  array</td>
                <td class="description">
                    <p><a href="#AdvScanDir"><span class="lilac">AdvScanDir</span></a>(<span class="lilac">string</span> <span class="blue">$directory</span>, <span class="lilac">string</span> <span class="blue">$mask</span>, <span class="lilac">string</span> <span class="blue">$type</span>, <span class="lilac">boolean</span> <span class="blue">$filter</span>, <span class="lilac">array</span> <span class="blue">$except</span>)</p>
                    <p class="description">Gets list of files from directory.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  array</td>
                <td class="description">
                    <p><a href="#AdvancedPagination"><span class="lilac">AdvancedPagination</span></a>(<span class="lilac">integer</span> <span class="blue">$total</span>, <span class="lilac">integer</span> <span class="blue">$current</span>, <span class="lilac">integer</span> <span class="blue">$last</span>)</p>
                    <p class="description">Formats data for pagination.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#CheckCaptcha"><span class="lilac">CheckCaptcha</span></a>()</p>
                    <p class="description">Checks captcha code.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  void</td>
                <td class="description">
                    <p><a href="#CreateUrl"><span class="lilac">CreateUrl</span></a>(<span class="lilac">string</span> <span class="blue">$module</span>, <span class="lilac">string</span> <span class="blue">$section</span>, <span class="lilac">integer</span> <span class="blue">$category</span>, <span class="lilac">integer</span> <span class="blue">$item</span>, <span class="lilac">integer</span> <span class="blue">$comment</span>, <span class="lilac">integer</span> <span class="blue">$page</span>)</p>
                    <p class="description">Creates url to the specified page.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#DeleteTree"><span class="lilac">DeleteTree</span></a>(<span class="lilac">string</span> <span class="blue">$object</span>, <span class="lilac">boolean</span> <span class="blue">$recursive</span>)</p>
                    <p class="description">Removes files and directories recursively.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#FormatTime"><span class="lilac">FormatTime</span></a>(<span class="lilac">string</span> <span class="blue">$format</span>, <span class="lilac">string</span> <span class="blue">$date</span>)</p>
                    <p class="description">Formats date and time according to user's timezone.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  array</td>
                <td class="description">
                    <p><a href="#GetFilesList"><span class="lilac">GetFilesList</span></a>(<span class="lilac">string</span> <span class="blue">$directory</span>, <span class="lilac">array</span> <span class="blue">$except</span>)</p>
                    <p class="description">Gets the list of files from the specified directory.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  array</td>
                <td class="description">
                    <p><a href="#GetPagination"><span class="lilac">GetPagination</span></a>(<span class="lilac">integer</span> <span class="blue">$page</span>, <span class="lilac">integer</span> <span class="blue">$perpage</span>, <span class="lilac">integer</span> <span class="blue">$count</span>)</p>
                    <p class="description">Culculates parameters for the pagination</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string|boolean</td>
                <td class="description">
                    <p><a href="#OnlyLatin"><span class="lilac">OnlyLatin</span></a>(<span class="lilac">string</span> <span class="blue">$string</span>)</p>
                    <p class="description">Checks if the string has onle latin symbols.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#Pagination"><span class="lilac">Pagination</span></a>(<span class="lilac">integer</span> <span class="blue">$total</span>, <span class="lilac">integer</span> <span class="blue">$perpage</span>, <span class="lilac">integer</span> <span class="blue">$current</span>, <span class="lilac">string</span> <span class="blue">$link</span>)</p>
                    <p class="description">Creates html block for pages navigation.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#RandomString"><span class="lilac">RandomString</span></a>(<span class="lilac">integer</span> <span class="blue">$num_chars</span>)</p>
                    <p class="description">Generates random string.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  void</td>
                <td class="description">
                    <p><a href="#Redirect"><span class="lilac">Redirect</span></a>(<span class="lilac">string</span> <span class="blue">$module</span>, <span class="lilac">string</span> <span class="blue">$section</span>, <span class="lilac">integer</span> <span class="blue">$category</span>, <span class="lilac">integer</span> <span class="blue">$item</span>, <span class="lilac">integer</span> <span class="blue">$page</span>, <span class="lilac">integer</span> <span class="blue">$comment</span>, <span class="lilac">string</span> <span class="blue">$post</span>)</p>
                    <p class="description">Redirects to the specified page.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#SelectTimeZone"><span class="lilac">SelectTimeZone</span></a>(<span class="lilac">string</span> <span class="blue">$name</span>, <span class="lilac">array</span> <span class="blue">$points</span>, <span class="lilac">string</span> <span class="blue">$default</span>)</p>
                    <p class="description">Selects the time zone.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#SendMail"><span class="lilac">SendMail</span></a>(<span class="lilac">string</span> <span class="blue">$to</span>, <span class="lilac">string</span> <span class="blue">$from</span>, <span class="lilac">string</span> <span class="blue">$sender</span>, <span class="lilac">string</span> <span class="blue">$subj</span>, <span class="lilac">string</span> <span class="blue">$text</span>)</p>
                    <p class="description">Sends email.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#ShowCaptcha"><span class="lilac">ShowCaptcha</span></a>(<span class="lilac">string</span> <span class="blue">$param</span>)</p>
                    <p class="description">Shows captcha.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  void</td>
                <td class="description">
                    <p><a href="#Sitemap"><span class="lilac">Sitemap</span></a>()</p>
                    <p class="description">Creates sitemap.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#UnifyBr"><span class="lilac">UnifyBr</span></a>(<span class="lilac">string</span> <span class="blue">$text</span>)</p>
                    <p class="description">Converts line endings.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#"><span class="lilac"></span></a>(<span class="lilac">string</span> <span class="blue">$string</span>)</p>
                    <p class="description">String localization.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  mixed</td>
                <td class="description">
                    <p><a href="#gzfile_get_contents"><span class="lilac">gzfile_get_contents</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>)</p>
                    <p class="description">Gets content of gziped file.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#gzfile_put_contents"><span class="lilac">gzfile_put_contents</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$text</span>, <span class="lilac">string</span> <span class="blue">$mode</span>)</p>
                    <p class="description">Writes data to gziped file.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#idxErrorHandler"><span class="lilac">idxErrorHandler</span></a>(<span class="lilac">integer</span> <span class="blue">$num</span>, <span class="lilac">string</span> <span class="blue">$msg</span>, <span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">integer</span> <span class="blue">$line</span>)</p>
                    <p class="description">Set error handler.</p>
                </td>
            </tr>
            </table>
    <h2 id="details_functions">Functions</h2>
            <div class="location">system/functions.php at line 24</div>
        <code id="AdvScanDir" class="arguments">public  array <strong>AdvScanDir</strong> (<span class="lilac">string</span> <span class="blue">$directory</span>, <span class="lilac">string</span> <span class="blue">$mask</span>, <span class="lilac">string</span> <span class="blue">$type</span>, <span class="lilac">boolean</span> <span class="blue">$filter</span>, <span class="lilac">array</span> <span class="blue">$except</span>)</code>
        <div class="details">
            Gets list of files from directory.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$directory</td>
                <td class="hid">Directory for parsing</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$mask</td>
                <td class="hid">Files mask</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$type</td>
                <td class="hid">Files type: file or directory</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$filter</td>
                <td class="hid">Files filter</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$except</td>
                <td class="hid">List if files which will be excluded from result</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">List of files</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 243</div>
        <code id="AdvancedPagination" class="arguments">public  array <strong>AdvancedPagination</strong> (<span class="lilac">integer</span> <span class="blue">$total</span>, <span class="lilac">integer</span> <span class="blue">$current</span>, <span class="lilac">integer</span> <span class="blue">$last</span>)</code>
        <div class="details">
            Formats data for pagination.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$total</td>
                <td class="hid">Pages amount</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$current</td>
                <td class="hid">Current page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$last</td>
                <td class="hid">Last page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Formatted data for pagination</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 421</div>
        <code id="CheckCaptcha" class="arguments">public  boolean <strong>CheckCaptcha</strong> ()</code>
        <div class="details">
            Checks captcha code.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Throws</td>
            <td class="hid right w_100 lilac">Exception</td>
                            <td class="hid" colspan="2"><span class="red">"Invalid captcha code"</span></td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 461</div>
        <code id="CreateUrl" class="arguments">public  void <strong>CreateUrl</strong> (<span class="lilac">string</span> <span class="blue">$module</span>, <span class="lilac">string</span> <span class="blue">$section</span>, <span class="lilac">integer</span> <span class="blue">$category</span>, <span class="lilac">integer</span> <span class="blue">$item</span>, <span class="lilac">integer</span> <span class="blue">$comment</span>, <span class="lilac">integer</span> <span class="blue">$page</span>)</code>
        <div class="details">
            Creates url to the specified page.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$module</td>
                <td class="hid">Module name</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$section</td>
                <td class="hid">Section name</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$category</td>
                <td class="hid">Category ID</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$item</td>
                <td class="hid">Item ID</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$comment</td>
                <td class="hid">Comment ID</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$page</td>
                <td class="hid">Page</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 60</div>
        <code id="DeleteTree" class="arguments">public  boolean <strong>DeleteTree</strong> (<span class="lilac">string</span> <span class="blue">$object</span>, <span class="lilac">boolean</span> <span class="blue">$recursive</span>)</code>
        <div class="details">
            Removes files and directories recursively.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$object</td>
                <td class="hid">Directory to remove</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$recursive</td>
                <td class="hid">Remove recursively? (Default : TRUE)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 195</div>
        <code id="FormatTime" class="arguments">public  string <strong>FormatTime</strong> (<span class="lilac">string</span> <span class="blue">$format</span>, <span class="lilac">string</span> <span class="blue">$date</span>)</code>
        <div class="details">
            Formats date and time according to user's timezone.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$format</td>
                <td class="hid">Format</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$date</td>
                <td class="hid">Date</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Formatted date/time</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 77</div>
        <code id="GetFilesList" class="arguments">public  array <strong>GetFilesList</strong> (<span class="lilac">string</span> <span class="blue">$directory</span>, <span class="lilac">array</span> <span class="blue">$except</span>)</code>
        <div class="details">
            Gets the list of files from the specified directory.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$directory</td>
                <td class="hid">Name of the directory</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$except</td>
                <td class="hid">The list of files to exclude from the result</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">The list of files from the specified directory</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 350</div>
        <code id="GetPagination" class="arguments">public  array <strong>GetPagination</strong> (<span class="lilac">integer</span> <span class="blue">$page</span>, <span class="lilac">integer</span> <span class="blue">$perpage</span>, <span class="lilac">integer</span> <span class="blue">$count</span>)</code>
        <div class="details">
            Culculates parameters for the pagination            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$page</td>
                <td class="hid">Number of the current page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$perpage</td>
                <td class="hid">Items per page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$count</td>
                <td class="hid">Number of items</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Parameters for the pagination</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 152</div>
        <code id="OnlyLatin" class="arguments">public  string|boolean <strong>OnlyLatin</strong> (<span class="lilac">string</span> <span class="blue">$string</span>)</code>
        <div class="details">
            Checks if the string has onle latin symbols.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$string</td>
                <td class="hid">String to check</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string|boolean</td>
                            <td class="hid" colspan="2">Checked string or FALSE if it has not only latin symbols</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 313</div>
        <code id="Pagination" class="arguments">public  string <strong>Pagination</strong> (<span class="lilac">integer</span> <span class="blue">$total</span>, <span class="lilac">integer</span> <span class="blue">$perpage</span>, <span class="lilac">integer</span> <span class="blue">$current</span>, <span class="lilac">string</span> <span class="blue">$link</span>)</code>
        <div class="details">
            Creates html block for pages navigation.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$total</td>
                <td class="hid">Total items</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$perpage</td>
                <td class="hid">Items per page</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$current</td>
                <td class="hid">Current page number</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$link</td>
                <td class="hid">Link to item</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">html block for pages navigation</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Todo</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Crate the template for pagination</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 162</div>
        <code id="RandomString" class="arguments">public  string <strong>RandomString</strong> (<span class="lilac">integer</span> <span class="blue">$num_chars</span>)</code>
        <div class="details">
            Generates random string.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$num_chars</td>
                <td class="hid">The lenght of string to generate</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Generated string</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 445</div>
        <code id="Redirect" class="arguments">public  void <strong>Redirect</strong> (<span class="lilac">string</span> <span class="blue">$module</span>, <span class="lilac">string</span> <span class="blue">$section</span>, <span class="lilac">integer</span> <span class="blue">$category</span>, <span class="lilac">integer</span> <span class="blue">$item</span>, <span class="lilac">integer</span> <span class="blue">$page</span>, <span class="lilac">integer</span> <span class="blue">$comment</span>, <span class="lilac">string</span> <span class="blue">$post</span>)</code>
        <div class="details">
            Redirects to the specified page.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$module</td>
                <td class="hid">Module name</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$section</td>
                <td class="hid">Section name (Default : NULL)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$category</td>
                <td class="hid">Category ID (Default : NULL)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$item</td>
                <td class="hid">Item ID (Default : NULL)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$page</td>
                <td class="hid">Page (Default : NULL)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$comment</td>
                <td class="hid">Comment ID (Default : NULL)</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 368</div>
        <code id="SelectTimeZone" class="arguments">public  string <strong>SelectTimeZone</strong> (<span class="lilac">string</span> <span class="blue">$name</span>, <span class="lilac">array</span> <span class="blue">$points</span>, <span class="lilac">string</span> <span class="blue">$default</span>)</code>
        <div class="details">
            Selects the time zone.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Time zone</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$points</td>
                <td class="hid">List of time zones</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$default</td>
                <td class="hid">The default time zone</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Form to select time zone</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 221</div>
        <code id="SendMail" class="arguments">public  boolean <strong>SendMail</strong> (<span class="lilac">string</span> <span class="blue">$to</span>, <span class="lilac">string</span> <span class="blue">$from</span>, <span class="lilac">string</span> <span class="blue">$sender</span>, <span class="lilac">string</span> <span class="blue">$subj</span>, <span class="lilac">string</span> <span class="blue">$text</span>)</code>
        <div class="details">
            Sends email.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$to</td>
                <td class="hid">The recipient</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$from</td>
                <td class="hid">Sender address</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$sender</td>
                <td class="hid">The sender</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$subj</td>
                <td class="hid">Subject</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$text</td>
                <td class="hid">Text</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of email sending</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 389</div>
        <code id="ShowCaptcha" class="arguments">public  string <strong>ShowCaptcha</strong> (<span class="lilac">string</span> <span class="blue">$param</span>)</code>
        <div class="details">
            Shows captcha.<br /> There are three different options:<ul><li>original: black in white;</li><li>color: with colored background;</li><li>random selection.</li></ul>The length of the captcha code also varies randomly from five to eight letters and numbers.<br /> Captcha is displayed only for unregistered users.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$param</td>
                <td class="hid">Type of captcha</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Captcha image and input field for captcha code</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 486</div>
        <code id="Sitemap" class="arguments">public  void <strong>Sitemap</strong> ()</code>
        <div class="details">
            Creates sitemap.<br /> return boolean The result of operation                    </div>
            <div class="location">system/functions.php at line 182</div>
        <code id="UnifyBr" class="arguments">public  string <strong>UnifyBr</strong> (<span class="lilac">string</span> <span class="blue">$text</span>)</code>
        <div class="details">
            Converts line endings.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$text</td>
                <td class="hid">Text to parse</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Parsed text</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 141</div>
        <code id="" class="arguments">public  string <strong></strong> (<span class="lilac">string</span> <span class="blue">$string</span>)</code>
        <div class="details">
            String localization.<br /> Currently, the system supports foure languages: English, Russian, Belarusian, and Ukrainian.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Global</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">array $LANG Array of language strings</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$string</td>
                <td class="hid">String to be translated</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Nhfyslated string</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 95</div>
        <code id="gzfile_get_contents" class="arguments">public  mixed <strong>gzfile_get_contents</strong> (<span class="lilac">string</span> <span class="blue">$file</span>)</code>
        <div class="details">
            Gets content of gziped file.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Name of the file</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">mixed</td>
                            <td class="hid" colspan="2">The content of file or FALSE</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">system/functions.php at line 113</div>
        <code id="gzfile_put_contents" class="arguments">public  boolean <strong>gzfile_put_contents</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$text</span>, <span class="lilac">string</span> <span class="blue">$mode</span>)</code>
        <div class="details">
            Writes data to gziped file.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Filename</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$text</td>
                <td class="hid">Data to gzip</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$mode</td>
                <td class="hid">Write mode (Default : 'w</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">index.php at line 111</div>
        <code id="idxErrorHandler" class="arguments">public  string <strong>idxErrorHandler</strong> (<span class="lilac">integer</span> <span class="blue">$num</span>, <span class="lilac">string</span> <span class="blue">$msg</span>, <span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">integer</span> <span class="blue">$line</span>)</code>
        <div class="details">
            Set error handler.<br /> Handles php errors and writes info into the /content/logs/idxerror.log.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$num</td>
                <td class="hid">Error number</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$msg</td>
                <td class="hid">Error message</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Name of the file where the error was generated</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$line</td>
                <td class="hid">Line number where the error was generated</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">$error Error message</td>
                    </tr>
        </table>
</div>
        </div>
                    <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../core/package-summary.html">Namespace</a></li>
                    <li class="active">Function</li>
                    <li><a href="../core/package-tree.html">Core\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links"><a href="#details_functions">Functions</a></div>
</nav>
            </div>
        </div>
    </div>
    <div class="footer">
        <div class="content">
            <div class="copyright center">Generated by <a href="https://github.com/Greenray/phpAPI" target="_blank">phpAPI</a>: PHP Documentation Creator ver. 6.0 &copy; 2015 - 2016 Greenray</div>
        </div>
    </div>
</body>
</html>
